[IMP] Appraisals: Update main doc #13141
Conversation
|
|
larm-odoo
force-pushed
the
18.0-appraisals-update-config-larm
branch
from
1020b5b to
0d50b90
Compare
|
Hi @justinmallette - this is ready for a peer review! |
larm-odoo
force-pushed
the
18.0-appraisals-update-config-larm
branch
from
0d50b90 to
ea35554
Compare
|
Hi @Felicious - this is ready for a final review! |
| @@ -16,121 +15,119 @@ promotions, and other benefits. | |||
| Regular appraisals are good for both the employees and the company, since they can accurately | |||
| measure performance based on company goals, and show employees where they need to improve. | |||
There was a problem hiding this comment.
I'd like to take some time to provide a totally optional rewrite to the introduction. The original has all the key features and delivers the value proposition of the Appraisal app. It's already strong!
I've drafted a more concise version and walk you through what changed and why I'm changing it, so you understand my reasoning, and hopefully this guides you to be consistently concise in your documentation 😊
Proposed rewrite
The Appraisals app provides a structured, repeatable way to review performance and set goals. Managers schedule reviews, employees complete self-assessments, and both sides record feedback in one place. Custom templates, rating scales, and 360° feedback keep each review aligned with company objectives and highlight concrete next steps—information managers can later use for raises, promotions, or training plans.
Why this version works better
| Goal | Original | Rewrite | Rationale |
|---|---|---|---|
| Lead with value | Opens by stating the app “is used to evaluate employee performance.” | Opens with the outcome: “a structured, repeatable way to review performance and set goals.” | Hooks readers with what they gain first, not the mechanics. |
| Keep it concise | Several sentences repeat why appraisals are useful. | Consolidates benefits into two focused sentences. | Reduces reading time while preserving meaning. |
| Avoid generic phrasing | “Good for both the employees and the company.” | Lists specific results: feedback, goals, raises, promotions, training plans. | Concrete examples feel more actionable than generic praise. |
Your draft contained all the right ingredients—I just repackaged them so readers can grasp the value faster. Feel free to use or adapt this rewrite, and let me know if any part of the reasoning isn’t clear. Happy to chat or pair on edits.
Great work getting the substance down; these small tweaks push it over the finish line. 🚀
larm-odoo
force-pushed
the
18.0-appraisals-update-config-larm
branch
from
ea35554 to
893c3c4
Compare
|
Hi @Felicious - just cleaning up my open PR's. This was on hold while the entire Appraisals folder of docs was updated and added to. So now, I just need to remove the redundant info that is on other docs. Should be a super simple review! =) |
There was a problem hiding this comment.
Looks good @larm-odoo ! I added a comment to change the page title to "Appraisals" (:
A couple random things unrelated to the writing:
- Since we moved the content of this page out in other PRs, I think we can "demote" this PR from a 3 point rewrite to a 2 point removal. So can you change the points to reflect that?
- Let's modify the PR description to reflect the changes that are reflected in this PR. How about changing the PR description to something like:
Configuration and overview content is now on individual appraisal pages (#13230, #13373, #13244). This PR removes the redundant overview page.
larm-odoo
force-pushed
the
18.0-appraisals-update-config-larm
branch
from
893c3c4 to
14460d5
Compare
|
Hi @samueljlieber - this should be a quick tech review (I hope!) =) |
There was a problem hiding this comment.
Hi @larm-odoo, looks good– before merging please remove the following unused image files:
content/applications/hr/appraisals/evaluation-scale.pngcontent/applications/hr/appraisals/survey-list.png
Thank you!
..
@robodoo delegate=larm-odoo
|
@robodoo r+ |
Configuration and overview content is now on individual appraisal pages (#13230, #13373, #13244). This PR removes the redundant overview page.